PDF4Java Reference Documentation
com.o2sol.pdf4java.annotations Package / PDFTextMarkupAnnotation Class


In This Topic
    PDFTextMarkupAnnotation Class Methods
    In This Topic

    For a list of all members of this type, see PDFTextMarkupAnnotation members.

    Public Methods
     NameDescription
    Public MethodSignals the start of the initialization of annotation's properties.
    The annotation appearance is not updated while properties are initialized. When initialization is completed, call to signal the end of initialization and update the annotation appearance. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets a value indicating whether the annotation should be rotated when the page is rotated. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodCreates the visual appearance for the annotation.
    This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodCreates the visual appearance for the annotation.
    This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public Methodstatic (Shared in Visual Basic)This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public Methodstatic (Shared in Visual Basic)This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSignals the end of the initialization of annotation's properties.
    The annotation appearance is updated when the initialization ends. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodMerges the annotation appearance with the page content stream.
    After the annotation is flattened, it is removed from the page's annotations collection. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the annotation author. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
    Public MethodGets the annotation contents. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the COS annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the annotation creation date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the display quad points.  
    Public MethodGets the display rectangle of this annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the annotation ID. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the annotation that this annotation is "in reply to". (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
    Public MethodGets the annotation modified date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the mouse down action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the mouse enter action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the mouse leave action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the mouse up action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the annotation normal appearance. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the annotation opacity. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
    Public MethodGets the page that contains this annotation.. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the page close action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the page invisible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the page open action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the page visible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the annotation rectangle in standard PDF coordinates. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the associated popup annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the annotation rotation angle. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the annotation subject. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
    Public MethodGets the annotation markup color.  
    Public MethodGets the type of the annotation markup.  
    Public MethodGets a value indicating whether the interpretation of isViewable method should be reversed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets the type of the annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodGets a value indicating whether to display the annotation or not. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets a value indicating whether the annotation should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets a value indicating whether the annotation contents should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets a value indicating whether the annotation should be printed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets a value indicating whether the annotation is read only. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets a value indicating whether the annotation should be displayed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodGets a value indicating whether the annotation should be scaled to current page zoom. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation author. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
    Public MethodSets a value indicating whether the annotation should be rotated when the page is rotated. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation contents. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation creation date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the display quad points. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order:
    x1 y1 x2 y2 x3 y3 x4 y4
    specifying the quadrilateral's four vertices in counterclockwise order.
    Note: This is the Acrobat order that the library also uses: (x1 y1) is the top left corner, (x2 y2) is the top right corner, (x3 y3) is the bottom left corner, (x4 y4) is the bottom right corner.  
    Public MethodSets the display rectangle of this annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets a value indicating whether to display the annotation or not. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation ID. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation that this annotation is "in reply to". (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
    Public MethodSets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets a value indicating whether the annotation should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets a value indicating whether the annotation contents should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation modified date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the mouse down action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the mouse enter action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the mouse leave action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the mouse up action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation normal appearance. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation opacity. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
    Public MethodSets the page close action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the page invisible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the page open action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the page visible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation rectangle in standard PDF coordinates.  
    Public MethodSets the associated popup annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets a value indicating whether the annotation should be printed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets a value indicating whether the annotation is read only. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation rotation angle.
    The accepted values for this property are 0, 90, 180 and 270 degrees. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets the annotation subject. (Inherited from com.o2sol.pdf4java.annotations.PDFMarkupAnnotation)
    Public MethodSets the annotation markup color.
    Color must be Gray, RGB or CMYK.  
    Public MethodSets the type of the annotation markup.  
    Public MethodSets a value indicating whether the interpretation of isViewable method should be reversed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets a value indicating whether the annotation should be displayed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodSets a value indicating whether the annotation should be scaled to current page zoom. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Public MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Top
    Protected Methods
     NameDescription
    Protected MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Protected MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Protected MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Protected MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Protected MethodThis method supports the internal library infrastructure and should not be used by external client code.  
    Protected MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Protected MethodThis method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
    Protected MethodThis method supports the internal library infrastructure and should not be used by external client code.  
    Top
    See Also